package com.learn.cloud.validator.annotation;

import com.learn.cloud.validator.constraints.StatusValueValidator;
import jakarta.validation.Constraint;
import jakarta.validation.Payload;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * @description: 状态校验，校验参数的状态是否是 StatusEnum 中的值
 * @author: cong zhi
 * @createDate: 2022/2/6 1:31
 * @updateUser: cong zhi
 * @updateDate: 2022/2/6 1:31
 * @updateRemark: 修改内容
 * @version: v1.0
 */
@Documented
@Constraint(validatedBy = StatusValueValidator.class)
@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
public @interface StatusValue {
    /**
     * 默认错误消息
     */
    String message() default "不正确的状态标识";
    /**
     * 支持枚举列表验证
     */
    Class<?> value();
    /**
     * 这里主要进行将validator进行分类，不同的类group中会执行不同的validator操作
     * @return
     */
    Class[] groups() default {};

    /**
     * payload 主要是针对bean的，使用不多。
     * @return
     */
    Class<? extends Payload>[] payload() default {};

    /**
     * 是否必填
     * <p>
     * 如果必填，在校验的时候本字段没值就会报错
     */
    boolean required() default true;

    @Target({ElementType.FIELD, ElementType.PARAMETER})
    @Retention(RUNTIME)
    @Documented
    @interface List {
        StatusValue[] value();
    }
}
